<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /* ========================================================================<a name="line.1"></a>
<FONT color="green">002</FONT>     * JCommon : a free general purpose class library for the Java(tm) platform<a name="line.2"></a>
<FONT color="green">003</FONT>     * ========================================================================<a name="line.3"></a>
<FONT color="green">004</FONT>     *<a name="line.4"></a>
<FONT color="green">005</FONT>     * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.<a name="line.5"></a>
<FONT color="green">006</FONT>     * <a name="line.6"></a>
<FONT color="green">007</FONT>     * Project Info:  http://www.jfree.org/jcommon/index.html<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     * This library is free software; you can redistribute it and/or modify it <a name="line.9"></a>
<FONT color="green">010</FONT>     * under the terms of the GNU Lesser General Public License as published by <a name="line.10"></a>
<FONT color="green">011</FONT>     * the Free Software Foundation; either version 2.1 of the License, or <a name="line.11"></a>
<FONT color="green">012</FONT>     * (at your option) any later version.<a name="line.12"></a>
<FONT color="green">013</FONT>     *<a name="line.13"></a>
<FONT color="green">014</FONT>     * This library is distributed in the hope that it will be useful, but <a name="line.14"></a>
<FONT color="green">015</FONT>     * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY <a name="line.15"></a>
<FONT color="green">016</FONT>     * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public <a name="line.16"></a>
<FONT color="green">017</FONT>     * License for more details.<a name="line.17"></a>
<FONT color="green">018</FONT>     *<a name="line.18"></a>
<FONT color="green">019</FONT>     * You should have received a copy of the GNU Lesser General Public<a name="line.19"></a>
<FONT color="green">020</FONT>     * License along with this library; if not, write to the Free Software<a name="line.20"></a>
<FONT color="green">021</FONT>     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, <a name="line.21"></a>
<FONT color="green">022</FONT>     * USA.  <a name="line.22"></a>
<FONT color="green">023</FONT>     *<a name="line.23"></a>
<FONT color="green">024</FONT>     * [Java is a trademark or registered trademark of Sun Microsystems, Inc. <a name="line.24"></a>
<FONT color="green">025</FONT>     * in the United States and other countries.]<a name="line.25"></a>
<FONT color="green">026</FONT>     * <a name="line.26"></a>
<FONT color="green">027</FONT>     * ------------------------<a name="line.27"></a>
<FONT color="green">028</FONT>     * AbstractModelReader.java<a name="line.28"></a>
<FONT color="green">029</FONT>     * ------------------------<a name="line.29"></a>
<FONT color="green">030</FONT>     * (C)opyright 2003-2005, by Thomas Morgner and Contributors.<a name="line.30"></a>
<FONT color="green">031</FONT>     *<a name="line.31"></a>
<FONT color="green">032</FONT>     * Original Author:  Thomas Morgner;<a name="line.32"></a>
<FONT color="green">033</FONT>     * Contributor(s):   David Gilbert (for Object Refinery Limited);<a name="line.33"></a>
<FONT color="green">034</FONT>     *<a name="line.34"></a>
<FONT color="green">035</FONT>     * $Id: AbstractModelReader.java,v 1.8 2005/10/18 13:33:53 mungady Exp $<a name="line.35"></a>
<FONT color="green">036</FONT>     *<a name="line.36"></a>
<FONT color="green">037</FONT>     * Changes<a name="line.37"></a>
<FONT color="green">038</FONT>     * -------<a name="line.38"></a>
<FONT color="green">039</FONT>     * 12-Nov-2003 : Initial version<a name="line.39"></a>
<FONT color="green">040</FONT>     * 25-Nov-2003 : Updated header (DG);<a name="line.40"></a>
<FONT color="green">041</FONT>     *<a name="line.41"></a>
<FONT color="green">042</FONT>     */<a name="line.42"></a>
<FONT color="green">043</FONT>    <a name="line.43"></a>
<FONT color="green">044</FONT>    package org.jfree.xml.util;<a name="line.44"></a>
<FONT color="green">045</FONT>    <a name="line.45"></a>
<FONT color="green">046</FONT>    import java.io.BufferedInputStream;<a name="line.46"></a>
<FONT color="green">047</FONT>    import java.io.InputStream;<a name="line.47"></a>
<FONT color="green">048</FONT>    import java.net.URL;<a name="line.48"></a>
<FONT color="green">049</FONT>    import java.util.Stack;<a name="line.49"></a>
<FONT color="green">050</FONT>    <a name="line.50"></a>
<FONT color="green">051</FONT>    import javax.xml.parsers.SAXParser;<a name="line.51"></a>
<FONT color="green">052</FONT>    import javax.xml.parsers.SAXParserFactory;<a name="line.52"></a>
<FONT color="green">053</FONT>    <a name="line.53"></a>
<FONT color="green">054</FONT>    import org.jfree.util.Log;<a name="line.54"></a>
<FONT color="green">055</FONT>    import org.jfree.util.ObjectUtilities;<a name="line.55"></a>
<FONT color="green">056</FONT>    import org.jfree.xml.CommentHandler;<a name="line.56"></a>
<FONT color="green">057</FONT>    import org.jfree.xml.ElementDefinitionException;<a name="line.57"></a>
<FONT color="green">058</FONT>    import org.xml.sax.Attributes;<a name="line.58"></a>
<FONT color="green">059</FONT>    import org.xml.sax.InputSource;<a name="line.59"></a>
<FONT color="green">060</FONT>    import org.xml.sax.SAXException;<a name="line.60"></a>
<FONT color="green">061</FONT>    import org.xml.sax.XMLReader;<a name="line.61"></a>
<FONT color="green">062</FONT>    import org.xml.sax.helpers.DefaultHandler;<a name="line.62"></a>
<FONT color="green">063</FONT>    <a name="line.63"></a>
<FONT color="green">064</FONT>    /**<a name="line.64"></a>
<FONT color="green">065</FONT>     * Loads the class model from an previously written xml file set.<a name="line.65"></a>
<FONT color="green">066</FONT>     * This class provides abstract methods which get called during the parsing<a name="line.66"></a>
<FONT color="green">067</FONT>     * (similiar to the SAX parsing, but slightly easier to code).<a name="line.67"></a>
<FONT color="green">068</FONT>     *<a name="line.68"></a>
<FONT color="green">069</FONT>     * This will need a rewrite in the future, when the structure is finished.<a name="line.69"></a>
<FONT color="green">070</FONT>     */<a name="line.70"></a>
<FONT color="green">071</FONT>    public abstract class AbstractModelReader {<a name="line.71"></a>
<FONT color="green">072</FONT>    <a name="line.72"></a>
<FONT color="green">073</FONT>        /** The 'START' state. */<a name="line.73"></a>
<FONT color="green">074</FONT>        private static final int STATE_START = 0;<a name="line.74"></a>
<FONT color="green">075</FONT>        <a name="line.75"></a>
<FONT color="green">076</FONT>        /** The 'IN_OBJECT' state. */<a name="line.76"></a>
<FONT color="green">077</FONT>        private static final int IN_OBJECT = 1;<a name="line.77"></a>
<FONT color="green">078</FONT>    <a name="line.78"></a>
<FONT color="green">079</FONT>        /** The 'IGNORE_OBJECT' state. */<a name="line.79"></a>
<FONT color="green">080</FONT>        private static final int IGNORE_OBJECT = 2;<a name="line.80"></a>
<FONT color="green">081</FONT>        <a name="line.81"></a>
<FONT color="green">082</FONT>        /** The 'MAPPING' state. */<a name="line.82"></a>
<FONT color="green">083</FONT>        private static final int MAPPING_STATE = 3;<a name="line.83"></a>
<FONT color="green">084</FONT>        <a name="line.84"></a>
<FONT color="green">085</FONT>        /** The 'CONSTRUCTOR' state. */<a name="line.85"></a>
<FONT color="green">086</FONT>        private static final int CONSTRUCTOR_STATE = 4;<a name="line.86"></a>
<FONT color="green">087</FONT>    <a name="line.87"></a>
<FONT color="green">088</FONT>        /**<a name="line.88"></a>
<FONT color="green">089</FONT>         * The SAX2 callback implementation used for parsing the model xml files.<a name="line.89"></a>
<FONT color="green">090</FONT>         */<a name="line.90"></a>
<FONT color="green">091</FONT>        private class SAXModelHandler extends DefaultHandler {<a name="line.91"></a>
<FONT color="green">092</FONT>    <a name="line.92"></a>
<FONT color="green">093</FONT>            /** The resource URL. */<a name="line.93"></a>
<FONT color="green">094</FONT>            private URL resource;<a name="line.94"></a>
<FONT color="green">095</FONT>    <a name="line.95"></a>
<FONT color="green">096</FONT>            /** The current state. */<a name="line.96"></a>
<FONT color="green">097</FONT>            private int state;<a name="line.97"></a>
<FONT color="green">098</FONT>            <a name="line.98"></a>
<FONT color="green">099</FONT>            /** Open comments. */<a name="line.99"></a>
<FONT color="green">100</FONT>            private Stack openComments;<a name="line.100"></a>
<FONT color="green">101</FONT>            <a name="line.101"></a>
<FONT color="green">102</FONT>            /** Flag to track includes. */<a name="line.102"></a>
<FONT color="green">103</FONT>            private boolean isInclude;<a name="line.103"></a>
<FONT color="green">104</FONT>    <a name="line.104"></a>
<FONT color="green">105</FONT>            /**<a name="line.105"></a>
<FONT color="green">106</FONT>             * Creates a new SAX handler for parsing the model.<a name="line.106"></a>
<FONT color="green">107</FONT>             *<a name="line.107"></a>
<FONT color="green">108</FONT>             * @param resource  the resource URL.<a name="line.108"></a>
<FONT color="green">109</FONT>             * @param isInclude  an include?<a name="line.109"></a>
<FONT color="green">110</FONT>             */<a name="line.110"></a>
<FONT color="green">111</FONT>            public SAXModelHandler(final URL resource, final boolean isInclude) {<a name="line.111"></a>
<FONT color="green">112</FONT>                if (resource == null) {<a name="line.112"></a>
<FONT color="green">113</FONT>                    throw new NullPointerException();<a name="line.113"></a>
<FONT color="green">114</FONT>                }<a name="line.114"></a>
<FONT color="green">115</FONT>                this.resource = resource;<a name="line.115"></a>
<FONT color="green">116</FONT>                this.openComments = new Stack();<a name="line.116"></a>
<FONT color="green">117</FONT>                this.isInclude = isInclude;<a name="line.117"></a>
<FONT color="green">118</FONT>            }<a name="line.118"></a>
<FONT color="green">119</FONT>    <a name="line.119"></a>
<FONT color="green">120</FONT>            /**<a name="line.120"></a>
<FONT color="green">121</FONT>             * Receive notification of the start of an element.<a name="line.121"></a>
<FONT color="green">122</FONT>             *<a name="line.122"></a>
<FONT color="green">123</FONT>             * @param uri The Namespace URI, or the empty string if the<a name="line.123"></a>
<FONT color="green">124</FONT>             *        element has no Namespace URI or if Namespace<a name="line.124"></a>
<FONT color="green">125</FONT>             *        processing is not being performed.<a name="line.125"></a>
<FONT color="green">126</FONT>             * @param localName The local name (without prefix), or the<a name="line.126"></a>
<FONT color="green">127</FONT>             *        empty string if Namespace processing is not being<a name="line.127"></a>
<FONT color="green">128</FONT>             *        performed.<a name="line.128"></a>
<FONT color="green">129</FONT>             * @param qName The qualified name (with prefix), or the<a name="line.129"></a>
<FONT color="green">130</FONT>             *        empty string if qualified names are not available.<a name="line.130"></a>
<FONT color="green">131</FONT>             * @param attributes The attributes attached to the element.  If<a name="line.131"></a>
<FONT color="green">132</FONT>             *        there are no attributes, it shall be an empty<a name="line.132"></a>
<FONT color="green">133</FONT>             *        Attributes object.<a name="line.133"></a>
<FONT color="green">134</FONT>             * @exception SAXException Any SAX exception, possibly<a name="line.134"></a>
<FONT color="green">135</FONT>             *            wrapping another exception.<a name="line.135"></a>
<FONT color="green">136</FONT>             * <a name="line.136"></a>
<FONT color="green">137</FONT>             * @see org.xml.sax.ContentHandler#startElement<a name="line.137"></a>
<FONT color="green">138</FONT>             */<a name="line.138"></a>
<FONT color="green">139</FONT>            public void startElement(final String uri, final String localName,<a name="line.139"></a>
<FONT color="green">140</FONT>                                     final String qName, final Attributes attributes)<a name="line.140"></a>
<FONT color="green">141</FONT>                throws SAXException {<a name="line.141"></a>
<FONT color="green">142</FONT>    <a name="line.142"></a>
<FONT color="green">143</FONT>                setOpenComment(getCommentHandler().getComments());<a name="line.143"></a>
<FONT color="green">144</FONT>                this.openComments.push(getOpenComment());<a name="line.144"></a>
<FONT color="green">145</FONT>                setCloseComment(null);<a name="line.145"></a>
<FONT color="green">146</FONT>    <a name="line.146"></a>
<FONT color="green">147</FONT>                try {<a name="line.147"></a>
<FONT color="green">148</FONT>    <a name="line.148"></a>
<FONT color="green">149</FONT>                    if (!this.isInclude &amp;&amp; qName.equals(ClassModelTags.OBJECTS_TAG)) {<a name="line.149"></a>
<FONT color="green">150</FONT>                        //Log.debug ("Open Comments: " + openComment);<a name="line.150"></a>
<FONT color="green">151</FONT>                        startRootDocument();<a name="line.151"></a>
<FONT color="green">152</FONT>                        return;<a name="line.152"></a>
<FONT color="green">153</FONT>                    }<a name="line.153"></a>
<FONT color="green">154</FONT>    <a name="line.154"></a>
<FONT color="green">155</FONT>                    if (getState() == STATE_START) {<a name="line.155"></a>
<FONT color="green">156</FONT>                        startRootElement(qName, attributes);<a name="line.156"></a>
<FONT color="green">157</FONT>                    }<a name="line.157"></a>
<FONT color="green">158</FONT>                    else if (getState() == IGNORE_OBJECT) {<a name="line.158"></a>
<FONT color="green">159</FONT>                        return;<a name="line.159"></a>
<FONT color="green">160</FONT>                    }<a name="line.160"></a>
<FONT color="green">161</FONT>                    else if (getState() == IN_OBJECT) {<a name="line.161"></a>
<FONT color="green">162</FONT>                        startObjectElement(qName, attributes);<a name="line.162"></a>
<FONT color="green">163</FONT>                    }<a name="line.163"></a>
<FONT color="green">164</FONT>                    else if (getState() == MAPPING_STATE) {<a name="line.164"></a>
<FONT color="green">165</FONT>                        if (!qName.equals(ClassModelTags.TYPE_TAG)) {<a name="line.165"></a>
<FONT color="green">166</FONT>                            throw new SAXException("Expected 'type' tag");<a name="line.166"></a>
<FONT color="green">167</FONT>                        }<a name="line.167"></a>
<FONT color="green">168</FONT>                        final String name = attributes.getValue(ClassModelTags.NAME_ATTR);<a name="line.168"></a>
<FONT color="green">169</FONT>                        final String target = attributes.getValue(ClassModelTags.CLASS_ATTR);<a name="line.169"></a>
<FONT color="green">170</FONT>                        handleMultiplexMapping(name, target);<a name="line.170"></a>
<FONT color="green">171</FONT>                    }<a name="line.171"></a>
<FONT color="green">172</FONT>                    else if (getState() == CONSTRUCTOR_STATE) {<a name="line.172"></a>
<FONT color="green">173</FONT>                        if (!qName.equals(ClassModelTags.PARAMETER_TAG)) {<a name="line.173"></a>
<FONT color="green">174</FONT>                            throw new SAXException("Expected 'parameter' tag");<a name="line.174"></a>
<FONT color="green">175</FONT>                        }<a name="line.175"></a>
<FONT color="green">176</FONT>                        final String parameterClass = attributes.getValue(ClassModelTags.CLASS_ATTR);<a name="line.176"></a>
<FONT color="green">177</FONT>                        final String tagName = attributes.getValue(ClassModelTags.PROPERTY_ATTR); // optional<a name="line.177"></a>
<FONT color="green">178</FONT>                        handleConstructorDefinition(tagName, parameterClass);<a name="line.178"></a>
<FONT color="green">179</FONT>                    }<a name="line.179"></a>
<FONT color="green">180</FONT>                }<a name="line.180"></a>
<FONT color="green">181</FONT>                catch (ObjectDescriptionException e) {<a name="line.181"></a>
<FONT color="green">182</FONT>                    throw new SAXException(e);<a name="line.182"></a>
<FONT color="green">183</FONT>                }<a name="line.183"></a>
<FONT color="green">184</FONT>                finally {<a name="line.184"></a>
<FONT color="green">185</FONT>                    getCommentHandler().clearComments();<a name="line.185"></a>
<FONT color="green">186</FONT>                }<a name="line.186"></a>
<FONT color="green">187</FONT>            }<a name="line.187"></a>
<FONT color="green">188</FONT>    <a name="line.188"></a>
<FONT color="green">189</FONT>            /**<a name="line.189"></a>
<FONT color="green">190</FONT>             * Receive notification of the end of an element.<a name="line.190"></a>
<FONT color="green">191</FONT>             *<a name="line.191"></a>
<FONT color="green">192</FONT>             * @param uri The Namespace URI, or the empty string if the<a name="line.192"></a>
<FONT color="green">193</FONT>             *        element has no Namespace URI or if Namespace<a name="line.193"></a>
<FONT color="green">194</FONT>             *        processing is not being performed.<a name="line.194"></a>
<FONT color="green">195</FONT>             * @param localName The local name (without prefix), or the<a name="line.195"></a>
<FONT color="green">196</FONT>             *        empty string if Namespace processing is not being<a name="line.196"></a>
<FONT color="green">197</FONT>             *        performed.<a name="line.197"></a>
<FONT color="green">198</FONT>             * @param qName The qualified name (with prefix), or the<a name="line.198"></a>
<FONT color="green">199</FONT>             *        empty string if qualified names are not available.<a name="line.199"></a>
<FONT color="green">200</FONT>             * @exception SAXException Any SAX exception, possibly<a name="line.200"></a>
<FONT color="green">201</FONT>             *            wrapping another exception.<a name="line.201"></a>
<FONT color="green">202</FONT>             * @see org.xml.sax.ContentHandler#endElement<a name="line.202"></a>
<FONT color="green">203</FONT>             */<a name="line.203"></a>
<FONT color="green">204</FONT>            public void endElement(final String uri, final String localName, final String qName)<a name="line.204"></a>
<FONT color="green">205</FONT>                throws SAXException {<a name="line.205"></a>
<FONT color="green">206</FONT>    <a name="line.206"></a>
<FONT color="green">207</FONT>                setOpenComment((String[]) this.openComments.pop());<a name="line.207"></a>
<FONT color="green">208</FONT>                setCloseComment(getCommentHandler().getComments());<a name="line.208"></a>
<FONT color="green">209</FONT>    <a name="line.209"></a>
<FONT color="green">210</FONT>                try {<a name="line.210"></a>
<FONT color="green">211</FONT>                    if (!this.isInclude &amp;&amp; qName.equals(ClassModelTags.OBJECTS_TAG)) {<a name="line.211"></a>
<FONT color="green">212</FONT>                        endRootDocument();<a name="line.212"></a>
<FONT color="green">213</FONT>                        return;<a name="line.213"></a>
<FONT color="green">214</FONT>                    }<a name="line.214"></a>
<FONT color="green">215</FONT>    <a name="line.215"></a>
<FONT color="green">216</FONT>                    if (qName.equals(ClassModelTags.OBJECT_TAG)) {<a name="line.216"></a>
<FONT color="green">217</FONT>                        if (getState() != IGNORE_OBJECT) {<a name="line.217"></a>
<FONT color="green">218</FONT>                            endObjectDefinition();<a name="line.218"></a>
<FONT color="green">219</FONT>                        }<a name="line.219"></a>
<FONT color="green">220</FONT>                        setState(STATE_START);<a name="line.220"></a>
<FONT color="green">221</FONT>                    }<a name="line.221"></a>
<FONT color="green">222</FONT>                    else if (qName.equals(ClassModelTags.MAPPING_TAG)) {<a name="line.222"></a>
<FONT color="green">223</FONT>                        setState(STATE_START);<a name="line.223"></a>
<FONT color="green">224</FONT>                        endMultiplexMapping();<a name="line.224"></a>
<FONT color="green">225</FONT>                    }<a name="line.225"></a>
<FONT color="green">226</FONT>                    else if (qName.equals(ClassModelTags.CONSTRUCTOR_TAG)) {<a name="line.226"></a>
<FONT color="green">227</FONT>                        if (getState() != IGNORE_OBJECT) {<a name="line.227"></a>
<FONT color="green">228</FONT>                            setState(IN_OBJECT);<a name="line.228"></a>
<FONT color="green">229</FONT>                        }<a name="line.229"></a>
<FONT color="green">230</FONT>                    }<a name="line.230"></a>
<FONT color="green">231</FONT>                }<a name="line.231"></a>
<FONT color="green">232</FONT>                catch (ObjectDescriptionException e) {<a name="line.232"></a>
<FONT color="green">233</FONT>                    throw new SAXException(e);<a name="line.233"></a>
<FONT color="green">234</FONT>                }<a name="line.234"></a>
<FONT color="green">235</FONT>                finally {<a name="line.235"></a>
<FONT color="green">236</FONT>                    getCommentHandler().clearComments();<a name="line.236"></a>
<FONT color="green">237</FONT>                }<a name="line.237"></a>
<FONT color="green">238</FONT>            }<a name="line.238"></a>
<FONT color="green">239</FONT>    <a name="line.239"></a>
<FONT color="green">240</FONT>            /**<a name="line.240"></a>
<FONT color="green">241</FONT>             * Handles the start of an element within an object definition.<a name="line.241"></a>
<FONT color="green">242</FONT>             *<a name="line.242"></a>
<FONT color="green">243</FONT>             * @param qName The qualified name (with prefix), or the<a name="line.243"></a>
<FONT color="green">244</FONT>             *        empty string if qualified names are not available.<a name="line.244"></a>
<FONT color="green">245</FONT>             * @param attributes The attributes attached to the element.  If<a name="line.245"></a>
<FONT color="green">246</FONT>             *        there are no attributes, it shall be an empty<a name="line.246"></a>
<FONT color="green">247</FONT>             *        Attributes object.<a name="line.247"></a>
<FONT color="green">248</FONT>             * @throws ObjectDescriptionException if an error occured while<a name="line.248"></a>
<FONT color="green">249</FONT>             *        handling this tag<a name="line.249"></a>
<FONT color="green">250</FONT>             */<a name="line.250"></a>
<FONT color="green">251</FONT>            private void startObjectElement(final String qName, final Attributes attributes)<a name="line.251"></a>
<FONT color="green">252</FONT>                throws ObjectDescriptionException {<a name="line.252"></a>
<FONT color="green">253</FONT>                if (qName.equals(ClassModelTags.CONSTRUCTOR_TAG)) {<a name="line.253"></a>
<FONT color="green">254</FONT>                    setState(CONSTRUCTOR_STATE);<a name="line.254"></a>
<FONT color="green">255</FONT>                }<a name="line.255"></a>
<FONT color="green">256</FONT>                else if (qName.equals(ClassModelTags.LOOKUP_PROPERTY_TAG)) {<a name="line.256"></a>
<FONT color="green">257</FONT>                    final String name = attributes.getValue(ClassModelTags.NAME_ATTR);<a name="line.257"></a>
<FONT color="green">258</FONT>                    final String lookupKey = attributes.getValue(ClassModelTags.LOOKUP_ATTR);<a name="line.258"></a>
<FONT color="green">259</FONT>                    handleLookupDefinition(name, lookupKey);<a name="line.259"></a>
<FONT color="green">260</FONT>                }<a name="line.260"></a>
<FONT color="green">261</FONT>                else if (qName.equals(ClassModelTags.IGNORED_PROPERTY_TAG)) {<a name="line.261"></a>
<FONT color="green">262</FONT>                    final String name = attributes.getValue(ClassModelTags.NAME_ATTR);<a name="line.262"></a>
<FONT color="green">263</FONT>                    handleIgnoredProperty(name);<a name="line.263"></a>
<FONT color="green">264</FONT>                }<a name="line.264"></a>
<FONT color="green">265</FONT>                else if (qName.equals(ClassModelTags.ELEMENT_PROPERTY_TAG)) {<a name="line.265"></a>
<FONT color="green">266</FONT>                    final String elementAtt = attributes.getValue(ClassModelTags.ELEMENT_ATTR);<a name="line.266"></a>
<FONT color="green">267</FONT>                    final String name = attributes.getValue(ClassModelTags.NAME_ATTR);<a name="line.267"></a>
<FONT color="green">268</FONT>                    handleElementDefinition(name, elementAtt);<a name="line.268"></a>
<FONT color="green">269</FONT>                }<a name="line.269"></a>
<FONT color="green">270</FONT>                else if (qName.equals(ClassModelTags.ATTRIBUTE_PROPERTY_TAG)) {<a name="line.270"></a>
<FONT color="green">271</FONT>                    final String name = attributes.getValue(ClassModelTags.NAME_ATTR);<a name="line.271"></a>
<FONT color="green">272</FONT>                    final String attribName = attributes.getValue(ClassModelTags.ATTRIBUTE_ATTR);<a name="line.272"></a>
<FONT color="green">273</FONT>                    final String handler = attributes.getValue(ClassModelTags.ATTRIBUTE_HANDLER_ATTR);<a name="line.273"></a>
<FONT color="green">274</FONT>                    handleAttributeDefinition(name, attribName, handler);<a name="line.274"></a>
<FONT color="green">275</FONT>                }<a name="line.275"></a>
<FONT color="green">276</FONT>            }<a name="line.276"></a>
<FONT color="green">277</FONT>    <a name="line.277"></a>
<FONT color="green">278</FONT>            /**<a name="line.278"></a>
<FONT color="green">279</FONT>             * Handles the include or object tag.<a name="line.279"></a>
<FONT color="green">280</FONT>             *<a name="line.280"></a>
<FONT color="green">281</FONT>             * @param qName The qualified name (with prefix), or the<a name="line.281"></a>
<FONT color="green">282</FONT>             *        empty string if qualified names are not available.<a name="line.282"></a>
<FONT color="green">283</FONT>             * @param attributes The attributes attached to the element.  If<a name="line.283"></a>
<FONT color="green">284</FONT>             *        there are no attributes, it shall be an empty<a name="line.284"></a>
<FONT color="green">285</FONT>             *        Attributes object.<a name="line.285"></a>
<FONT color="green">286</FONT>             * @throws SAXException if an parser error occured<a name="line.286"></a>
<FONT color="green">287</FONT>             * @throws ObjectDescriptionException if an object model related<a name="line.287"></a>
<FONT color="green">288</FONT>             *        error occured.<a name="line.288"></a>
<FONT color="green">289</FONT>             */<a name="line.289"></a>
<FONT color="green">290</FONT>            private void startRootElement(final String qName, final Attributes attributes)<a name="line.290"></a>
<FONT color="green">291</FONT>                throws SAXException, ObjectDescriptionException {<a name="line.291"></a>
<FONT color="green">292</FONT>    <a name="line.292"></a>
<FONT color="green">293</FONT>                if (qName.equals(ClassModelTags.INCLUDE_TAG)) {<a name="line.293"></a>
<FONT color="green">294</FONT>                    if (this.isInclude) {<a name="line.294"></a>
<FONT color="green">295</FONT>                        Log.warn("Ignored nested include tag.");<a name="line.295"></a>
<FONT color="green">296</FONT>                        return;<a name="line.296"></a>
<FONT color="green">297</FONT>                    }<a name="line.297"></a>
<FONT color="green">298</FONT>                    final String src = attributes.getValue(ClassModelTags.SOURCE_ATTR);<a name="line.298"></a>
<FONT color="green">299</FONT>                    try {<a name="line.299"></a>
<FONT color="green">300</FONT>                        final URL url = new URL(this.resource, src);<a name="line.300"></a>
<FONT color="green">301</FONT>                        startIncludeHandling(url);<a name="line.301"></a>
<FONT color="green">302</FONT>                        parseXmlDocument(url, true);<a name="line.302"></a>
<FONT color="green">303</FONT>                        endIncludeHandling();<a name="line.303"></a>
<FONT color="green">304</FONT>                    }<a name="line.304"></a>
<FONT color="green">305</FONT>                    catch (Exception ioe) {<a name="line.305"></a>
<FONT color="green">306</FONT>                        throw new ElementDefinitionException<a name="line.306"></a>
<FONT color="green">307</FONT>                            (ioe, "Unable to include file from " + src);<a name="line.307"></a>
<FONT color="green">308</FONT>                    }<a name="line.308"></a>
<FONT color="green">309</FONT>                }<a name="line.309"></a>
<FONT color="green">310</FONT>                else if (qName.equals(ClassModelTags.OBJECT_TAG)) {<a name="line.310"></a>
<FONT color="green">311</FONT>                    setState(IN_OBJECT);<a name="line.311"></a>
<FONT color="green">312</FONT>                    final String className = attributes.getValue(ClassModelTags.CLASS_ATTR);<a name="line.312"></a>
<FONT color="green">313</FONT>                    String register = attributes.getValue(ClassModelTags.REGISTER_NAMES_ATTR);<a name="line.313"></a>
<FONT color="green">314</FONT>                    if (register != null &amp;&amp; register.length() == 0) {<a name="line.314"></a>
<FONT color="green">315</FONT>                        register = null;<a name="line.315"></a>
<FONT color="green">316</FONT>                    }<a name="line.316"></a>
<FONT color="green">317</FONT>                    final boolean ignored = "true".equals(attributes.getValue(ClassModelTags.IGNORE_ATTR));<a name="line.317"></a>
<FONT color="green">318</FONT>                    if (!startObjectDefinition(className, register, ignored)) {<a name="line.318"></a>
<FONT color="green">319</FONT>                        setState(IGNORE_OBJECT);<a name="line.319"></a>
<FONT color="green">320</FONT>                    }<a name="line.320"></a>
<FONT color="green">321</FONT>                }<a name="line.321"></a>
<FONT color="green">322</FONT>                else if (qName.equals(ClassModelTags.MANUAL_TAG)) {<a name="line.322"></a>
<FONT color="green">323</FONT>                    final String className = attributes.getValue(ClassModelTags.CLASS_ATTR);<a name="line.323"></a>
<FONT color="green">324</FONT>                    final String readHandler = attributes.getValue(ClassModelTags.READ_HANDLER_ATTR);<a name="line.324"></a>
<FONT color="green">325</FONT>                    final String writeHandler = attributes.getValue(ClassModelTags.WRITE_HANDLER_ATTR);<a name="line.325"></a>
<FONT color="green">326</FONT>                    handleManualMapping(className, readHandler, writeHandler);<a name="line.326"></a>
<FONT color="green">327</FONT>                }<a name="line.327"></a>
<FONT color="green">328</FONT>                else if (qName.equals(ClassModelTags.MAPPING_TAG)) {<a name="line.328"></a>
<FONT color="green">329</FONT>                    setState(MAPPING_STATE);<a name="line.329"></a>
<FONT color="green">330</FONT>                    final String typeAttr = attributes.getValue(ClassModelTags.TYPE_ATTR);<a name="line.330"></a>
<FONT color="green">331</FONT>                    final String baseClass = attributes.getValue(ClassModelTags.BASE_CLASS_ATTR);<a name="line.331"></a>
<FONT color="green">332</FONT>                    startMultiplexMapping(baseClass, typeAttr);<a name="line.332"></a>
<FONT color="green">333</FONT>                }<a name="line.333"></a>
<FONT color="green">334</FONT>            }<a name="line.334"></a>
<FONT color="green">335</FONT>    <a name="line.335"></a>
<FONT color="green">336</FONT>            /**<a name="line.336"></a>
<FONT color="green">337</FONT>             * Returns the current state.<a name="line.337"></a>
<FONT color="green">338</FONT>             *<a name="line.338"></a>
<FONT color="green">339</FONT>             * @return the state.<a name="line.339"></a>
<FONT color="green">340</FONT>             */<a name="line.340"></a>
<FONT color="green">341</FONT>            private int getState() {<a name="line.341"></a>
<FONT color="green">342</FONT>                return this.state;<a name="line.342"></a>
<FONT color="green">343</FONT>            }<a name="line.343"></a>
<FONT color="green">344</FONT>    <a name="line.344"></a>
<FONT color="green">345</FONT>            /**<a name="line.345"></a>
<FONT color="green">346</FONT>             * Sets the current state.<a name="line.346"></a>
<FONT color="green">347</FONT>             *<a name="line.347"></a>
<FONT color="green">348</FONT>             * @param state  the state.<a name="line.348"></a>
<FONT color="green">349</FONT>             */<a name="line.349"></a>
<FONT color="green">350</FONT>            private void setState(final int state) {<a name="line.350"></a>
<FONT color="green">351</FONT>                this.state = state;<a name="line.351"></a>
<FONT color="green">352</FONT>            }<a name="line.352"></a>
<FONT color="green">353</FONT>        }<a name="line.353"></a>
<FONT color="green">354</FONT>    <a name="line.354"></a>
<FONT color="green">355</FONT>        /** The comment handler. */<a name="line.355"></a>
<FONT color="green">356</FONT>        private CommentHandler commentHandler;<a name="line.356"></a>
<FONT color="green">357</FONT>        <a name="line.357"></a>
<FONT color="green">358</FONT>        /** The close comments. */<a name="line.358"></a>
<FONT color="green">359</FONT>        private String[] closeComment;<a name="line.359"></a>
<FONT color="green">360</FONT>        <a name="line.360"></a>
<FONT color="green">361</FONT>        /** The open comments. */<a name="line.361"></a>
<FONT color="green">362</FONT>        private String[] openComment;<a name="line.362"></a>
<FONT color="green">363</FONT>    <a name="line.363"></a>
<FONT color="green">364</FONT>        /**<a name="line.364"></a>
<FONT color="green">365</FONT>         * Default Constructor.<a name="line.365"></a>
<FONT color="green">366</FONT>         */<a name="line.366"></a>
<FONT color="green">367</FONT>        public AbstractModelReader() {<a name="line.367"></a>
<FONT color="green">368</FONT>            this.commentHandler = new CommentHandler();<a name="line.368"></a>
<FONT color="green">369</FONT>        }<a name="line.369"></a>
<FONT color="green">370</FONT>    <a name="line.370"></a>
<FONT color="green">371</FONT>        /**<a name="line.371"></a>
<FONT color="green">372</FONT>         * Returns the comment handler.<a name="line.372"></a>
<FONT color="green">373</FONT>         * <a name="line.373"></a>
<FONT color="green">374</FONT>         * @return The comment handler.<a name="line.374"></a>
<FONT color="green">375</FONT>         */<a name="line.375"></a>
<FONT color="green">376</FONT>        protected CommentHandler getCommentHandler() {<a name="line.376"></a>
<FONT color="green">377</FONT>            return this.commentHandler;<a name="line.377"></a>
<FONT color="green">378</FONT>        }<a name="line.378"></a>
<FONT color="green">379</FONT>    <a name="line.379"></a>
<FONT color="green">380</FONT>        /**<a name="line.380"></a>
<FONT color="green">381</FONT>         * Returns the close comment. <a name="line.381"></a>
<FONT color="green">382</FONT>         * <a name="line.382"></a>
<FONT color="green">383</FONT>         * @return The close comment.<a name="line.383"></a>
<FONT color="green">384</FONT>         */<a name="line.384"></a>
<FONT color="green">385</FONT>        protected String[] getCloseComment() {<a name="line.385"></a>
<FONT color="green">386</FONT>            return this.closeComment;<a name="line.386"></a>
<FONT color="green">387</FONT>        }<a name="line.387"></a>
<FONT color="green">388</FONT>    <a name="line.388"></a>
<FONT color="green">389</FONT>        /**<a name="line.389"></a>
<FONT color="green">390</FONT>         * Returns the open comment. <a name="line.390"></a>
<FONT color="green">391</FONT>         * <a name="line.391"></a>
<FONT color="green">392</FONT>         * @return The open comment.<a name="line.392"></a>
<FONT color="green">393</FONT>         */<a name="line.393"></a>
<FONT color="green">394</FONT>        protected String[] getOpenComment() {<a name="line.394"></a>
<FONT color="green">395</FONT>            return this.openComment;<a name="line.395"></a>
<FONT color="green">396</FONT>        }<a name="line.396"></a>
<FONT color="green">397</FONT>    <a name="line.397"></a>
<FONT color="green">398</FONT>        /**<a name="line.398"></a>
<FONT color="green">399</FONT>         * Sets the close comment.<a name="line.399"></a>
<FONT color="green">400</FONT>         * <a name="line.400"></a>
<FONT color="green">401</FONT>         * @param closeComment  the close comment.<a name="line.401"></a>
<FONT color="green">402</FONT>         */<a name="line.402"></a>
<FONT color="green">403</FONT>        protected void setCloseComment(final String[] closeComment) {<a name="line.403"></a>
<FONT color="green">404</FONT>            this.closeComment = closeComment;<a name="line.404"></a>
<FONT color="green">405</FONT>        }<a name="line.405"></a>
<FONT color="green">406</FONT>    <a name="line.406"></a>
<FONT color="green">407</FONT>        /**<a name="line.407"></a>
<FONT color="green">408</FONT>         * Sets the open comment.<a name="line.408"></a>
<FONT color="green">409</FONT>         * <a name="line.409"></a>
<FONT color="green">410</FONT>         * @param openComment  the open comment.<a name="line.410"></a>
<FONT color="green">411</FONT>         */<a name="line.411"></a>
<FONT color="green">412</FONT>        protected void setOpenComment(final String[] openComment) {<a name="line.412"></a>
<FONT color="green">413</FONT>            this.openComment = openComment;<a name="line.413"></a>
<FONT color="green">414</FONT>        }<a name="line.414"></a>
<FONT color="green">415</FONT>    <a name="line.415"></a>
<FONT color="green">416</FONT>        /**<a name="line.416"></a>
<FONT color="green">417</FONT>         * Parses an XML document at the given URL.<a name="line.417"></a>
<FONT color="green">418</FONT>         * <a name="line.418"></a>
<FONT color="green">419</FONT>         * @param resource  the document URL.<a name="line.419"></a>
<FONT color="green">420</FONT>         * <a name="line.420"></a>
<FONT color="green">421</FONT>         * @throws ObjectDescriptionException ??<a name="line.421"></a>
<FONT color="green">422</FONT>         */<a name="line.422"></a>
<FONT color="green">423</FONT>        protected void parseXml(final URL resource) throws ObjectDescriptionException {<a name="line.423"></a>
<FONT color="green">424</FONT>            parseXmlDocument(resource, false);<a name="line.424"></a>
<FONT color="green">425</FONT>        }<a name="line.425"></a>
<FONT color="green">426</FONT>    <a name="line.426"></a>
<FONT color="green">427</FONT>        /**<a name="line.427"></a>
<FONT color="green">428</FONT>         * Parses the given specification and loads all includes specified in the files.<a name="line.428"></a>
<FONT color="green">429</FONT>         * This implementation does not check for loops in the include files.<a name="line.429"></a>
<FONT color="green">430</FONT>         *<a name="line.430"></a>
<FONT color="green">431</FONT>         * @param resource  the url of the xml specification.<a name="line.431"></a>
<FONT color="green">432</FONT>         * @param isInclude  an include?<a name="line.432"></a>
<FONT color="green">433</FONT>         * <a name="line.433"></a>
<FONT color="green">434</FONT>         * @throws org.jfree.xml.util.ObjectDescriptionException if an error occured which prevented the<a name="line.434"></a>
<FONT color="green">435</FONT>         * loading of the specifications.<a name="line.435"></a>
<FONT color="green">436</FONT>         */<a name="line.436"></a>
<FONT color="green">437</FONT>        protected void parseXmlDocument(final URL resource, final boolean isInclude)<a name="line.437"></a>
<FONT color="green">438</FONT>            throws ObjectDescriptionException {<a name="line.438"></a>
<FONT color="green">439</FONT>            <a name="line.439"></a>
<FONT color="green">440</FONT>            try {<a name="line.440"></a>
<FONT color="green">441</FONT>                final InputStream in = new BufferedInputStream(resource.openStream());<a name="line.441"></a>
<FONT color="green">442</FONT>                final SAXParserFactory factory = SAXParserFactory.newInstance();<a name="line.442"></a>
<FONT color="green">443</FONT>                final SAXParser saxParser = factory.newSAXParser();<a name="line.443"></a>
<FONT color="green">444</FONT>                final XMLReader reader = saxParser.getXMLReader();<a name="line.444"></a>
<FONT color="green">445</FONT>    <a name="line.445"></a>
<FONT color="green">446</FONT>                final SAXModelHandler handler = new SAXModelHandler(resource, isInclude);<a name="line.446"></a>
<FONT color="green">447</FONT>                try {<a name="line.447"></a>
<FONT color="green">448</FONT>                    reader.setProperty<a name="line.448"></a>
<FONT color="green">449</FONT>                        ("http://xml.org/sax/properties/lexical-handler",<a name="line.449"></a>
<FONT color="green">450</FONT>                            getCommentHandler());<a name="line.450"></a>
<FONT color="green">451</FONT>                }<a name="line.451"></a>
<FONT color="green">452</FONT>                catch (SAXException se) {<a name="line.452"></a>
<FONT color="green">453</FONT>                    Log.debug("Comments are not supported by this SAX implementation.");<a name="line.453"></a>
<FONT color="green">454</FONT>                }<a name="line.454"></a>
<FONT color="green">455</FONT>                reader.setContentHandler(handler);<a name="line.455"></a>
<FONT color="green">456</FONT>                reader.setDTDHandler(handler);<a name="line.456"></a>
<FONT color="green">457</FONT>                reader.setErrorHandler(handler);<a name="line.457"></a>
<FONT color="green">458</FONT>                reader.parse(new InputSource(in));<a name="line.458"></a>
<FONT color="green">459</FONT>                in.close();<a name="line.459"></a>
<FONT color="green">460</FONT>            }<a name="line.460"></a>
<FONT color="green">461</FONT>            catch (Exception e) {<a name="line.461"></a>
<FONT color="green">462</FONT>                // unable to init<a name="line.462"></a>
<FONT color="green">463</FONT>                Log.warn("Unable to load factory specifications", e);<a name="line.463"></a>
<FONT color="green">464</FONT>                throw new ObjectDescriptionException("Unable to load object factory specs.", e);<a name="line.464"></a>
<FONT color="green">465</FONT>            }<a name="line.465"></a>
<FONT color="green">466</FONT>        }<a name="line.466"></a>
<FONT color="green">467</FONT>    <a name="line.467"></a>
<FONT color="green">468</FONT>        /**<a name="line.468"></a>
<FONT color="green">469</FONT>         * Start the root document.<a name="line.469"></a>
<FONT color="green">470</FONT>         */<a name="line.470"></a>
<FONT color="green">471</FONT>        protected void startRootDocument() {<a name="line.471"></a>
<FONT color="green">472</FONT>            // nothing required<a name="line.472"></a>
<FONT color="green">473</FONT>        }<a name="line.473"></a>
<FONT color="green">474</FONT>    <a name="line.474"></a>
<FONT color="green">475</FONT>        /**<a name="line.475"></a>
<FONT color="green">476</FONT>         * End the root document.<a name="line.476"></a>
<FONT color="green">477</FONT>         */<a name="line.477"></a>
<FONT color="green">478</FONT>        protected void endRootDocument() {<a name="line.478"></a>
<FONT color="green">479</FONT>            // nothing required<a name="line.479"></a>
<FONT color="green">480</FONT>        }<a name="line.480"></a>
<FONT color="green">481</FONT>    <a name="line.481"></a>
<FONT color="green">482</FONT>        /**<a name="line.482"></a>
<FONT color="green">483</FONT>         * Start handling an include.<a name="line.483"></a>
<FONT color="green">484</FONT>         * <a name="line.484"></a>
<FONT color="green">485</FONT>         * @param resource  the URL.<a name="line.485"></a>
<FONT color="green">486</FONT>         */<a name="line.486"></a>
<FONT color="green">487</FONT>        protected void startIncludeHandling(final URL resource) {<a name="line.487"></a>
<FONT color="green">488</FONT>            // nothing required<a name="line.488"></a>
<FONT color="green">489</FONT>        }<a name="line.489"></a>
<FONT color="green">490</FONT>    <a name="line.490"></a>
<FONT color="green">491</FONT>        /**<a name="line.491"></a>
<FONT color="green">492</FONT>         * End handling an include.<a name="line.492"></a>
<FONT color="green">493</FONT>         */<a name="line.493"></a>
<FONT color="green">494</FONT>        protected void endIncludeHandling() {<a name="line.494"></a>
<FONT color="green">495</FONT>            // nothing required<a name="line.495"></a>
<FONT color="green">496</FONT>        }<a name="line.496"></a>
<FONT color="green">497</FONT>    <a name="line.497"></a>
<FONT color="green">498</FONT>        /**<a name="line.498"></a>
<FONT color="green">499</FONT>         * Callback method for ignored properties. Such properties get marked so that<a name="line.499"></a>
<FONT color="green">500</FONT>         * the information regarding these properties won't get lost.<a name="line.500"></a>
<FONT color="green">501</FONT>         *<a name="line.501"></a>
<FONT color="green">502</FONT>         * @param name the name of the ignored property.<a name="line.502"></a>
<FONT color="green">503</FONT>         */<a name="line.503"></a>
<FONT color="green">504</FONT>        protected void handleIgnoredProperty(final String name) {<a name="line.504"></a>
<FONT color="green">505</FONT>            // nothing required<a name="line.505"></a>
<FONT color="green">506</FONT>        }<a name="line.506"></a>
<FONT color="green">507</FONT>    <a name="line.507"></a>
<FONT color="green">508</FONT>        /**<a name="line.508"></a>
<FONT color="green">509</FONT>         * Handles a manual mapping definition. The manual mapping maps specific<a name="line.509"></a>
<FONT color="green">510</FONT>         * read and write handlers to a given base class. Manual mappings always<a name="line.510"></a>
<FONT color="green">511</FONT>         * override any other definition.<a name="line.511"></a>
<FONT color="green">512</FONT>         *<a name="line.512"></a>
<FONT color="green">513</FONT>         * @param className the base class name<a name="line.513"></a>
<FONT color="green">514</FONT>         * @param readHandler the class name of the read handler<a name="line.514"></a>
<FONT color="green">515</FONT>         * @param writeHandler the class name of the write handler<a name="line.515"></a>
<FONT color="green">516</FONT>         * @return true, if the mapping was accepted, false otherwise.<a name="line.516"></a>
<FONT color="green">517</FONT>         * @throws ObjectDescriptionException if an unexpected error occured.<a name="line.517"></a>
<FONT color="green">518</FONT>         */<a name="line.518"></a>
<FONT color="green">519</FONT>        protected abstract boolean handleManualMapping(String className, String readHandler, <a name="line.519"></a>
<FONT color="green">520</FONT>            String writeHandler) throws ObjectDescriptionException;<a name="line.520"></a>
<FONT color="green">521</FONT>    <a name="line.521"></a>
<FONT color="green">522</FONT>        /**<a name="line.522"></a>
<FONT color="green">523</FONT>         * Starts a object definition. The object definition collects all properties of<a name="line.523"></a>
<FONT color="green">524</FONT>         * an bean-class and defines, which constructor should be used when creating the<a name="line.524"></a>
<FONT color="green">525</FONT>         * class.<a name="line.525"></a>
<FONT color="green">526</FONT>         *<a name="line.526"></a>
<FONT color="green">527</FONT>         * @param className the class name of the defined object<a name="line.527"></a>
<FONT color="green">528</FONT>         * @param register the (optional) register name, to lookup and reference the object<a name="line.528"></a>
<FONT color="green">529</FONT>         * later.<a name="line.529"></a>
<FONT color="green">530</FONT>         * @param ignored  ??.<a name="line.530"></a>
<FONT color="green">531</FONT>         * <a name="line.531"></a>
<FONT color="green">532</FONT>         * @return true, if the definition was accepted, false otherwise.<a name="line.532"></a>
<FONT color="green">533</FONT>         * @throws ObjectDescriptionException if an unexpected error occured.<a name="line.533"></a>
<FONT color="green">534</FONT>         */<a name="line.534"></a>
<FONT color="green">535</FONT>        protected abstract boolean startObjectDefinition(String className, String register,<a name="line.535"></a>
<FONT color="green">536</FONT>            boolean ignored) throws ObjectDescriptionException;<a name="line.536"></a>
<FONT color="green">537</FONT>    <a name="line.537"></a>
<FONT color="green">538</FONT>        /**<a name="line.538"></a>
<FONT color="green">539</FONT>         * Handles an attribute definition. This method gets called after the object definition<a name="line.539"></a>
<FONT color="green">540</FONT>         * was started. The method will be called for every defined attribute property.<a name="line.540"></a>
<FONT color="green">541</FONT>         *<a name="line.541"></a>
<FONT color="green">542</FONT>         * @param name the name of the property<a name="line.542"></a>
<FONT color="green">543</FONT>         * @param attribName the xml-attribute name to use later.<a name="line.543"></a>
<FONT color="green">544</FONT>         * @param handlerClass the attribute handler class.<a name="line.544"></a>
<FONT color="green">545</FONT>         * @throws ObjectDescriptionException if an error occured.<a name="line.545"></a>
<FONT color="green">546</FONT>         */<a name="line.546"></a>
<FONT color="green">547</FONT>        protected abstract void handleAttributeDefinition(String name, String attribName,<a name="line.547"></a>
<FONT color="green">548</FONT>                                                          String handlerClass)<a name="line.548"></a>
<FONT color="green">549</FONT>            throws ObjectDescriptionException;<a name="line.549"></a>
<FONT color="green">550</FONT>    <a name="line.550"></a>
<FONT color="green">551</FONT>        /**<a name="line.551"></a>
<FONT color="green">552</FONT>         * Handles an element definition. This method gets called after the object definition<a name="line.552"></a>
<FONT color="green">553</FONT>         * was started. The method will be called for every defined element property. Element<a name="line.553"></a>
<FONT color="green">554</FONT>         * properties are used to describe complex objects.<a name="line.554"></a>
<FONT color="green">555</FONT>         *<a name="line.555"></a>
<FONT color="green">556</FONT>         * @param name the name of the property<a name="line.556"></a>
<FONT color="green">557</FONT>         * @param element the xml-tag name for the child element.<a name="line.557"></a>
<FONT color="green">558</FONT>         * @throws ObjectDescriptionException if an error occurs.<a name="line.558"></a>
<FONT color="green">559</FONT>         */<a name="line.559"></a>
<FONT color="green">560</FONT>        protected abstract void handleElementDefinition(String name, String element) <a name="line.560"></a>
<FONT color="green">561</FONT>            throws ObjectDescriptionException;<a name="line.561"></a>
<FONT color="green">562</FONT>    <a name="line.562"></a>
<FONT color="green">563</FONT>        /**<a name="line.563"></a>
<FONT color="green">564</FONT>         * Handles an lookup definition. This method gets called after the object definition<a name="line.564"></a>
<FONT color="green">565</FONT>         * was started. The method will be called for every defined lookup property. Lookup properties<a name="line.565"></a>
<FONT color="green">566</FONT>         * reference previously created object using the object's registry name.<a name="line.566"></a>
<FONT color="green">567</FONT>         *<a name="line.567"></a>
<FONT color="green">568</FONT>         * @param name the property name of the base object<a name="line.568"></a>
<FONT color="green">569</FONT>         * @param lookupKey the register key of the referenced object<a name="line.569"></a>
<FONT color="green">570</FONT>         * @throws ObjectDescriptionException if an error occured.<a name="line.570"></a>
<FONT color="green">571</FONT>         */<a name="line.571"></a>
<FONT color="green">572</FONT>        protected abstract void handleLookupDefinition(String name, String lookupKey) <a name="line.572"></a>
<FONT color="green">573</FONT>            throws ObjectDescriptionException;<a name="line.573"></a>
<FONT color="green">574</FONT>    <a name="line.574"></a>
<FONT color="green">575</FONT>        /**<a name="line.575"></a>
<FONT color="green">576</FONT>         * Finializes the object definition.<a name="line.576"></a>
<FONT color="green">577</FONT>         *<a name="line.577"></a>
<FONT color="green">578</FONT>         * @throws ObjectDescriptionException if an error occures.<a name="line.578"></a>
<FONT color="green">579</FONT>         */<a name="line.579"></a>
<FONT color="green">580</FONT>        protected abstract void endObjectDefinition() throws ObjectDescriptionException;<a name="line.580"></a>
<FONT color="green">581</FONT>    <a name="line.581"></a>
<FONT color="green">582</FONT>        /**<a name="line.582"></a>
<FONT color="green">583</FONT>         * Starts a multiplex mapping. Multiplex mappings are used to define polymorphic<a name="line.583"></a>
<FONT color="green">584</FONT>         * argument handlers. The mapper will collect all derived classes of the given<a name="line.584"></a>
<FONT color="green">585</FONT>         * base class and will select the corresponding mapping based on the given type<a name="line.585"></a>
<FONT color="green">586</FONT>         * attribute.<a name="line.586"></a>
<FONT color="green">587</FONT>         *<a name="line.587"></a>
<FONT color="green">588</FONT>         * @param className the base class name<a name="line.588"></a>
<FONT color="green">589</FONT>         * @param typeAttr the xml-attribute name containing the mapping key<a name="line.589"></a>
<FONT color="green">590</FONT>         */<a name="line.590"></a>
<FONT color="green">591</FONT>        protected abstract void startMultiplexMapping(String className, String typeAttr);<a name="line.591"></a>
<FONT color="green">592</FONT>    <a name="line.592"></a>
<FONT color="green">593</FONT>        /**<a name="line.593"></a>
<FONT color="green">594</FONT>         * Defines an entry for the multiplex mapping. The new entry will be activated<a name="line.594"></a>
<FONT color="green">595</FONT>         * when the base mappers type attribute contains this &lt;code&gt;typename&lt;/code&gt; and<a name="line.595"></a>
<FONT color="green">596</FONT>         * will resolve to the handler for the given classname.<a name="line.596"></a>
<FONT color="green">597</FONT>         *<a name="line.597"></a>
<FONT color="green">598</FONT>         * @param typeName the type value for this mapping.<a name="line.598"></a>
<FONT color="green">599</FONT>         * @param className the class name to which this mapping resolves.<a name="line.599"></a>
<FONT color="green">600</FONT>         * @throws ObjectDescriptionException if an error occurs.<a name="line.600"></a>
<FONT color="green">601</FONT>         */<a name="line.601"></a>
<FONT color="green">602</FONT>        protected abstract void handleMultiplexMapping(String typeName, String className) <a name="line.602"></a>
<FONT color="green">603</FONT>            throws ObjectDescriptionException;<a name="line.603"></a>
<FONT color="green">604</FONT>    <a name="line.604"></a>
<FONT color="green">605</FONT>        /**<a name="line.605"></a>
<FONT color="green">606</FONT>         * Finializes the multiplexer mapping.<a name="line.606"></a>
<FONT color="green">607</FONT>         *<a name="line.607"></a>
<FONT color="green">608</FONT>         * @throws ObjectDescriptionException if an error occurs.<a name="line.608"></a>
<FONT color="green">609</FONT>         */<a name="line.609"></a>
<FONT color="green">610</FONT>        protected abstract void endMultiplexMapping() throws ObjectDescriptionException;<a name="line.610"></a>
<FONT color="green">611</FONT>    <a name="line.611"></a>
<FONT color="green">612</FONT>        /**<a name="line.612"></a>
<FONT color="green">613</FONT>         * Handles a constructor definition. Only one constructor can be defined for<a name="line.613"></a>
<FONT color="green">614</FONT>         * a certain object type. The constructor will be filled using the given properties.<a name="line.614"></a>
<FONT color="green">615</FONT>         *<a name="line.615"></a>
<FONT color="green">616</FONT>         * @param propertyName the property name of the referenced local property<a name="line.616"></a>
<FONT color="green">617</FONT>         * @param parameterClass the parameter class for the parameter.<a name="line.617"></a>
<FONT color="green">618</FONT>         * @throws ObjectDescriptionException if an error occured.<a name="line.618"></a>
<FONT color="green">619</FONT>         */<a name="line.619"></a>
<FONT color="green">620</FONT>        protected abstract void handleConstructorDefinition(String propertyName, String parameterClass)<a name="line.620"></a>
<FONT color="green">621</FONT>            throws ObjectDescriptionException;<a name="line.621"></a>
<FONT color="green">622</FONT>    <a name="line.622"></a>
<FONT color="green">623</FONT>        /**<a name="line.623"></a>
<FONT color="green">624</FONT>         * Loads the given class, and ignores all exceptions which may occur<a name="line.624"></a>
<FONT color="green">625</FONT>         * during the loading. If the class was invalid, null is returned instead.<a name="line.625"></a>
<FONT color="green">626</FONT>         *<a name="line.626"></a>
<FONT color="green">627</FONT>         * @param className the name of the class to be loaded.<a name="line.627"></a>
<FONT color="green">628</FONT>         * @return the class or null.<a name="line.628"></a>
<FONT color="green">629</FONT>         */<a name="line.629"></a>
<FONT color="green">630</FONT>        protected Class loadClass(final String className) {<a name="line.630"></a>
<FONT color="green">631</FONT>            if (className == null) {<a name="line.631"></a>
<FONT color="green">632</FONT>                return null;<a name="line.632"></a>
<FONT color="green">633</FONT>            }<a name="line.633"></a>
<FONT color="green">634</FONT>            if (className.startsWith("::")) {<a name="line.634"></a>
<FONT color="green">635</FONT>                return BasicTypeSupport.getClassRepresentation(className);<a name="line.635"></a>
<FONT color="green">636</FONT>            }<a name="line.636"></a>
<FONT color="green">637</FONT>            try {<a name="line.637"></a>
<FONT color="green">638</FONT>                return ObjectUtilities.getClassLoader(getClass()).loadClass(className);<a name="line.638"></a>
<FONT color="green">639</FONT>            }<a name="line.639"></a>
<FONT color="green">640</FONT>            catch (Exception e) {<a name="line.640"></a>
<FONT color="green">641</FONT>                // ignore buggy classes for now ..<a name="line.641"></a>
<FONT color="green">642</FONT>                Log.warn("Unable to load class", e);<a name="line.642"></a>
<FONT color="green">643</FONT>                return null;<a name="line.643"></a>
<FONT color="green">644</FONT>            }<a name="line.644"></a>
<FONT color="green">645</FONT>        }<a name="line.645"></a>
<FONT color="green">646</FONT>    <a name="line.646"></a>
<FONT color="green">647</FONT>    }<a name="line.647"></a>




























































</PRE>
</BODY>
</HTML>
